/*
 * Copyright (C) 2015 Daniel Uppenkamp
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.maurersmarbles;

/**
 *
 * @author Daniel Uppenkamp
 */
public class Marble {

    /**
     * The board index that the marble is in.
     */
    protected int boardIndex;
    /**
     * The number for the marble.
     */
    protected int marbleNumber;
    /**
     * The player number that the marble belongs to.
     */
    protected int playerNumber;

    /**
     * Creates a new marble.
     *
     * @param playerNumber the player number that the marble belongs
     * @param marbleNumber the marble number
     * @param boardIndex the board index that the marble is in
     */
    public Marble(int playerNumber, int marbleNumber, int boardIndex) {
        this.playerNumber = playerNumber;
        this.marbleNumber = marbleNumber;
        this.boardIndex = boardIndex;
    }

    /**
     * Returns the board index that the marble is in.
     *
     * @return the board index that the marble is in
     */
    public int getBoardIndex() {
        return boardIndex;
    }

    /**
     * Sets the board index that the marble is in.
     *
     * @param boardIndex the board index that the marble is in
     */
    public void setBoardIndex(int boardIndex) {
        this.boardIndex = boardIndex;
    }

    /**
     * Returns the number for the marble.
     *
     * @return the number for the marble
     */
    public int getMarbleNumber() {
        return marbleNumber;
    }

    /**
     * Returns the player number that this marble belongs to.
     *
     * @return the player number that this marble belongs to
     */
    public int getPlayerNumber() {
        return playerNumber;
    }

}
